/*$$
 * Copyright (c) 1999, Trustees of the University of Chicago
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with 
 * or without modification, are permitted provided that the following 
 * conditions are met:
 *
 *	 Redistributions of source code must retain the above copyright notice,
 *	 this list of conditions and the following disclaimer.
 *
 *	 Redistributions in binary form must reproduce the above copyright notice,
 *	 this list of conditions and the following disclaimer in the documentation
 *	 and/or other materials provided with the distribution.
 *
 * Neither the name of the University of Chicago nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE TRUSTEES OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *$$*/
package uchicago.src.sim.gui;

import java.awt.event.ActionEvent;
import java.util.ArrayList;
import java.util.List;

/**
 * Abstract implementation of the GraphLayout interface. This implements
 * basic list operations, but no layout algorithm. Sub-classes are expected
 * to implement updateLayout() to do the actual layout of the nodes in the
 * nodeList. In addition subclasses may override the empty ActionListener
 * implementation provided here.
 *
 * @author Nick Collier
 * @version $Revision: 1.6 $ $Date: 2004/11/03 19:50:59 $
 */
public abstract class AbstractGraphLayout implements GraphLayout {

  protected ArrayList nodeList;
  protected int width, height;
  protected boolean update = true;

  public AbstractGraphLayout(int width, int height) {
    nodeList = new ArrayList();
    this.width = width;
    this.height = height;
  }

  public AbstractGraphLayout(List nodes, int width, int height) {
    this.width = width;
    this.height = height;
    nodeList = new ArrayList(nodes);
  }

  /**
   * Gets the height of the area on which to layout the graph.
   */
  public int getHeight() {
    return height;
  }

  /**
   * Gets the width of the area on which to layout the graph.
   */
  public int getWidth() {
    return width;
  }

   /**
   * Sets the list of nodes to be laid out by this GraphLayout.
   */
  public void setList(List listOfNodes) {
    nodeList.clear();
    nodeList.addAll(listOfNodes);
  }

  /**
   * Appends a list of nodes to the current list of nodes to be laid
   * out by this GraphLayout.
   */
  public void appendToList(List listOfNodes) {
    nodeList.addAll(listOfNodes);
  }

  /**
   * Appends the specified nodes to the list of nodes to be laid out by
   * this GraphLayout.
   */
  public void appendToList(DrawableNonGridNode node) {
    nodeList.add(node);
  }

  /**
   * Gets the list of nodes.
   */
  public ArrayList getNodeList() {
    return nodeList;
  }

  public void setUpdate(boolean doUpdate) {
    update = doUpdate;
  }

  // ADD (cjw): Method to return update status
  public boolean getUpdate() {
    return update;
  }

  /**
   * Empty implementation of ActionListener interface. Sub-classes can
   * override this to provide their own implementations.
   */
  public void actionPerformed(ActionEvent evt) {}

  /**
   * Updates the layout of this graph by setting the x, y coordinate of
   * each DrawableNonGridNode in the current list of nodes.
   */
  public abstract void updateLayout();
}




